/* Copyright 2009
 *
 * This program and the accompanying materials
 * are made available under the terms of the
 * Eclipse Public License v1.0 which accompanies
 * this distribution, and is available at
 *
 * 		http://www.eclipse.org/legal/epl-v10.html
 *
 * Unless required by applicable law or agreed to in
 * writing, software distributed under the License is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
 * OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * Contributors:
 * 	   IBM Corporation - initial API and implementation for JDT/DLTK
 *     Sean W. Quinn - initial adoption for use with PHP from various sources.
 */
package org.eclipse.php.core;

import org.eclipse.dltk.core.Flags;
import org.eclipse.dltk.core.ISourceManipulation;
import org.eclipse.dltk.core.ISourceReference;

/**
 * Represents an import declaration in Java compilation unit.
 *
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IUseDeclaration extends IPHPElement, ISourceReference, ISourceManipulation {
	/**
	 * Returns the name that has been imported. For an on-demand import, this
	 * includes the trailing <code>".*"</code>. For example, for the statement
	 * <code>"import java.util.*"</code>, this returns
	 * <code>"java.util.*"</code>. For the statement
	 * <code>"import java.util.Hashtable"</code>, this returns
	 * <code>"java.util.Hashtable"</code>.
	 *
	 * @return the name that has been imported
	 */
	String getElementName();

	/**
	 * Returns the modifier flags for this import. The flags can be examined
	 * using class <code>Flags</code>. Only the static flag is meaningful for
	 * import declarations.
	 *
	 * @return the modifier flags for this import
	 * @exception PHPModelException if this element does not exist or if an
	 *                exception occurs while accessing its corresponding
	 *                resource.
	 * @see Flags
	 * @since 3.0
	 */
	int getFlags() throws PHPModelException;

	/**
	 * Returns whether the import is on-demand. An import is on-demand if it
	 * ends with <code>".*"</code>.
	 *
	 * @return true if the import is on-demand, false otherwise
	 */
	boolean isOnDemand();
}
